/**********************************************************************
 *** *                                                            * ***
 *** *  Copyright (c) 2013 Harmonia Holdings Group LLC            * ***
 *** *                                                            * ***
 *** * Permission is hereby granted to use, modify, copy, and     * ***
 *** * distribute this software and its documentation for any     * ***
 *** * purpose only without profit, provided that the above       * ***
 *** * Copyright Notice appears in all copies and that both the   * ***
 *** * Copyright Notice and this Permission Notice appears in     * ***
 *** * every copy of supporting documentation.  No title to nor   * ***
 *** * ownership of the software is transferred hereby.  The name * ***
 *** * of Harmonia Holdings Group LLC shall not be used in        * ***
 *** * advertising or publicity related to the distribution of    * ***
 *** * the software without specific, written, prior permission.  * ***
 *** * This software is provided as-delivered without expressed   * ***
 *** * or implied warranty.  Harmonia Holdings Group LLC          * ***
 *** * makes no representation about the suitability of this      * ***
 *** * software for any purpose and accepts no responsibility for * ***
 *** * its use.                                                   * ***
 *** *                                                            * ***
 *** ************************************************************** ***
 *** *                                                            * ***
 *** * This program is free software; you can redistribute it     * ***
 *** * and/or modify it under the terms of the GNU General Public * ***
 *** * License as published by the Free Software Foundation;      * ***
 *** * either version 2 of the License, or (at your option) any   * ***
 *** * later version.                                             * ***
 *** *                                                            * ***
 *** * This program is distributed in the hope that it will be    * ***
 *** * useful, but WITHOUT ANY WARRANTY; without even the implied * ***
 *** * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR    * ***
 *** * PURPOSE.  See the GNU General Public License for more      * ***
 *** * details.                                                   * ***
 *** *                                                            * ***
 *** * You should have received a copy of the GNU General Public  * ***
 *** * License along with this program; if not, write to the Free * ***
 *** * Software Foundation, Inc., 51 Franklin Street, Fifth       * ***
 *** * Floor, Boston, MA 02110-1301, USA.                         * ***
 *** *                                                            * ***
 *** * For more information: http://www.gnu.org/licenses/gpl.html * ***
 *** *                                                            * ***
 **********************************************************************/
package org.etexascode.interrep.datamodel;
import java.io.Serializable;

/**
 * The Vehicle Command Abstract Class
 * Contains variables used by all the other
 * sub classes.
 * @author jrutherford
 */
public class VehicleCommand implements Serializable
{
	/** Serial ID. */
	private static final long serialVersionUID = -1176639313058357218L;

	/** The vehicle ID. 0 for all. */
	private int vehicleID;
	
	/** The command to perform. */
	private int command;
	
	
	/** Constructor. */
	public VehicleCommand() { }
	public VehicleCommand(int vehicleID, int command) {
		this.vehicleID = vehicleID;
		this.command = command;
	}
	
	/**
	 * Gets the vehicle ID.
	 * @return The vehicle ID.
	 */
	public int getVehicleID() { return vehicleID; }
	
	// TODO: janway - added these setters to make jaxb work. Need to find a way to do without it.
	// The problem this fixes is when injecting vehicles using REST, the received VehicleInjectionCommand has a vehicleID of 0.
	// Have already tried adding the @XmlAccessorType(XmlAccessType.FIELD), with or without @XmlRootElement and @XmlElement annotations.
	// Also tried @XmlAccessorType(XmlAccessType.NONE).
	public void setVehicleID(int vehicleID) { this.vehicleID = vehicleID; }
	
	/**
	 * Gets the command to execute.
	 * @return Command constant from above.
	 */
	public int getCommand() { return command; }
	
	public void setCommand(int command) { this.command = command; }
}